Package com.cisco.pt.ipc.sim.impl
Class FlowMonitorImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.FlowMonitorImpl
- All Implemented Interfaces:
IPCObject,FlowMonitor
Information provided by the PKI file:
\class FlowMonitor
\brief FlowMonitor holds and manipulates the flow monitor.
\example network().getDevice("Router0").getNetflowMonitorManager().getMonitorAt(0)
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionFlowMonitorImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionintInformation provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:getExporterAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:getInterfaceInput(String interfaceName, boolean isIpv6) Information provided by the PKI file:getInterfaceOutput(String interfaceName, boolean isIpv6) Information provided by the PKI file:getMonitorDataAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:booleanInformation provided by the PKI file:toString()Information provided by the PKI file:voidInformation provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
FlowMonitorImpl
public FlowMonitorImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getMonitorName
Information provided by the PKI file:
\brief Returns the name of the flow monitor. \return string, the name of the flow monitor.- Specified by:
getMonitorNamein interfaceFlowMonitor- Returns:
- String Returns a String
-
getRecord
Information provided by the PKI file:
\brief Returns the flow record. \return FlowRecord, the FlowRecord object.- Specified by:
getRecordin interfaceFlowMonitor- Returns:
- FlowRecord Returns a FlowRecord
-
unsetRecord
public void unsetRecord()Information provided by the PKI file:
\brief Unsets the flow record.- Specified by:
unsetRecordin interfaceFlowMonitor
-
getInterfaceInput
Information provided by the PKI file:
\brief Returns the input flow monitor data on the specified interface. \param interfaceName, interfaceName can be one of the following plus an interface number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0 \param isIpv6, true if IPv6, false if IPv4. \return FlowMonitorData, the FlowMonitorData object.- Specified by:
getInterfaceInputin interfaceFlowMonitor- Parameters:
interfaceName- Takes in a parameter of interfaceNameisIpv6- Takes in a parameter of isIpv6- Returns:
- FlowMonitorData Returns a FlowMonitorData
-
getInterfaceOutput
Information provided by the PKI file:
\brief Returns the output flow monitor data on the specified interface. \param interfaceName, interfaceName can be one of the following plus an interface number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0 \param isIpv6, true if IPv6, false if IPv4. \return FlowMonitorData, the FlowMonitorData object.- Specified by:
getInterfaceOutputin interfaceFlowMonitor- Parameters:
interfaceName- Takes in a parameter of interfaceNameisIpv6- Takes in a parameter of isIpv6- Returns:
- FlowMonitorData Returns a FlowMonitorData
-
getActiveFlowCount
public int getActiveFlowCount()Information provided by the PKI file:
\brief Returns the number of active flows. \return int, the number of active flows.- Specified by:
getActiveFlowCountin interfaceFlowMonitor- Returns:
- int Returns a int
-
getTotalFlowAdded
public int getTotalFlowAdded()Information provided by the PKI file:
\brief Returns the total number of flows. \return int, the total number of flows.- Specified by:
getTotalFlowAddedin interfaceFlowMonitor- Returns:
- int Returns a int
-
getMonitorDataCount
public int getMonitorDataCount()Information provided by the PKI file:
\brief Returns the number of flow monitor data. \return int, the number of flow monitor data.- Specified by:
getMonitorDataCountin interfaceFlowMonitor- Returns:
- int Returns a int
-
getMonitorDataAt
Information provided by the PKI file:
\brief Returns the flow monitor data at the specified index. \param index, the index of the flow monitor data of interest. \return FlowMonitorData, the FlowMonitorData object at the specified index.- Specified by:
getMonitorDataAtin interfaceFlowMonitor- Parameters:
index- Takes in a parameter of index- Returns:
- FlowMonitorData Returns a FlowMonitorData
-
getExporterCount
public int getExporterCount()Information provided by the PKI file:
\brief Returns the number of NetFlow exporters. \return int, the number of NetFlow exporters.- Specified by:
getExporterCountin interfaceFlowMonitor- Returns:
- int Returns a int
-
getExporterAt
Information provided by the PKI file:
\brief Returns the NetFlow exporter at the specified index. \param index, the index of the NetFlow exporter of interest. \return NFExporter, the NFExporter object at the specified index.- Specified by:
getExporterAtin interfaceFlowMonitor- Parameters:
index- Takes in a parameter of index- Returns:
- NFExporter Returns a NFExporter
-
toString
Information provided by the PKI file:
\brief Returns the flow record output. \return string, the flow record output.- Specified by:
toStringin interfaceFlowMonitor- Overrides:
toStringin classObject- Returns:
- String Returns a String
-
monitorInUse
public boolean monitorInUse()Information provided by the PKI file:
\brief Returns true if the flow monitor is in use, otherwise false. \return bool, true if the flow monitor is in use, otherwise false.- Specified by:
monitorInUsein interfaceFlowMonitor- Returns:
- boolean Returns a boolean
-
getCurrentEntryCount
public int getCurrentEntryCount()Information provided by the PKI file:
\brief Returns the number of flows. \return int, the number of flows.- Specified by:
getCurrentEntryCountin interfaceFlowMonitor- Returns:
- int Returns a int
-
getHighWaterMark
public int getHighWaterMark()Information provided by the PKI file:
\brief Returns the high watermark value. \return int, the high watermark value.- Specified by:
getHighWaterMarkin interfaceFlowMonitor- Returns:
- int Returns a int
-
getFlowsAddedCount
public int getFlowsAddedCount()Information provided by the PKI file:
\brief Returns the total number of flows. \return int, the total number of flows.- Specified by:
getFlowsAddedCountin interfaceFlowMonitor- Returns:
- int Returns a int
-
getFlowsAgedCount
public int getFlowsAgedCount()Information provided by the PKI file:
\brief Returns the total number of expired flows. \return int, the total number of expired flows.- Specified by:
getFlowsAgedCountin interfaceFlowMonitor- Returns:
- int Returns a int
-
getActiveTimeoutCount
public int getActiveTimeoutCount()Information provided by the PKI file:
\brief Returns the total number of flows that were closed due to long activity. \return int, the total number of flows that were closed due to long activity.- Specified by:
getActiveTimeoutCountin interfaceFlowMonitor- Returns:
- int Returns a int
-
getInactiveTimeoutCount
public int getInactiveTimeoutCount()Information provided by the PKI file:
\brief Returns the total number of flows that were closed due to inactivity. \return int, the total number of flows that were closed due to inactivity.- Specified by:
getInactiveTimeoutCountin interfaceFlowMonitor- Returns:
- int Returns a int
-
getCacheDatabase
Information provided by the PKI file:
\brief Returns cache flow database. \return CacheFlowDatabase, the CacheFlowDatabase object.- Specified by:
getCacheDatabasein interfaceFlowMonitor- Returns:
- CacheFlowDatabase Returns a CacheFlowDatabase
-